Kanzi 3.9.10
kanzi::ShadowEffect2D Class Reference

Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes. More...

#include <kanzi/core.ui/effect/shadow_effect2d.hpp>

Inheritance diagram for kanzi::ShadowEffect2D:
[legend]

Public Types

enum class  Quality { Low , Normal , High , Count }
 Defines the visual quality levels of the shadow effect. More...
 
enum class  Type { DropShadow , InnerShadow , Count }
 Defines the types of the shadow effect. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr
 Binding host concept shared pointer type.
 
using BindingRuntimeConstIterator
 Const iterator for binding runtimes.
 
using BindingRuntimeContainer
 Container for binding runtimes.
 
using BindingRuntimeIterator
 Iterator for binding runtimes.
 

Public Member Functions

Vector2 getActualOffset () const
 Gets the value of ActualOffsetProperty.
 
float getAngle () const
 Gets the value of AngleProperty.
 
int getBlendMode () const
 Gets the value of BlendModeProperty.
 
float getBlurRadius () const
 Gets the value of BlurRadiusProperty.
 
ColorRGBA getColor () const
 Gets the value of ColorProperty.
 
float getDistance () const
 Gets the value of DistanceProperty.
 
Vector2 getOverrideOffset () const
 Gets the value of OverrideOffsetProperty.
 
ColorRGBA getPremultipliedColor () const
 Gets the premultiplied color used by the shadow effect.
 
Quality getQuality () const
 Gets the value of QualityProperty.
 
bool getShadowOnly () const
 Gets the value of ShadowOnlyProperty.
 
Type getType () const
 Gets the value of TypeProperty.
 
void setAngle (float value)
 Sets the value of AngleProperty.
 
void setBlendMode (int value)
 Sets the value of BlendModeProperty.
 
void setBlurRadius (float value)
 Sets the value of BlurRadiusProperty.
 
void setColor (ColorRGBA value)
 Sets the value of ColorProperty.
 
void setDistance (float value)
 Sets the value of DistanceProperty.
 
void setOverrideOffset (Vector2 value)
 Sets the value of OverrideOffsetProperty.
 
void setQuality (Quality value)
 Sets the value of QualityProperty.
 
void setShadowOnly (bool value)
 Sets the value of ShadowOnlyProperty.
 
void setType (Type value)
 Sets the value of TypeProperty.
 
- Public Member Functions inherited from kanzi::NodeEffect2D
void attach (Node *node)
 Attaches the node effect.
 
BindingLookupContextPtr createLookupContext (NodeEffect2DSharedPtr templateRoot)
 Creates a lookup context for a given effect.
 
NodeEffectRenderer2DUniquePtr createRenderer ()
 Creates a renderer instance.
 
void detach ()
 Detaches the node effect.
 
unsigned int getEffectPaddingChangeCounter () const
 Gets the effect quad padding change counter.
 
Vector4 getEffectQuadPadding () const
 Gets the effect quad padding.
 
Vector2 getEffectQuadPaddingOffset () const
 Gets the effect quad offset relative relative to the top-left corner of the node.
 
Vector2 getEffectQuadPaddingSize () const
 Gets the effect quad padding size.
 
bool getEnabled () const
 Gets the value of EnabledProperty.
 
NodegetHostNode () const
 Gets the node that hosts the effect.
 
NodeEffect2DgetParent () const
 Gets the parent of a node effect.
 
NodeEffectRenderer2DgetRendererInstance () const
 Gets a pointer to NodeEffectRenderer2D instance or null pointer if none exists.
 
NodeEffect2DSharedPtr getTemplateRoot () const
 Gets the template root of this node effect.
 
bool isAlphaRequired () const
 Indicates whether the effect requires alpha channel for the result.
 
bool isAttached () const
 Returns whether a node effect is attached to a node.
 
bool isAttaching () const
 Returns whether a node effect is attaching to a node.
 
bool isDetached () const
 Returns whether a node effect is detached from a node.
 
bool isDetaching () const
 Returns whether a node effect is detaching from a node.
 
bool isRenderingRequired ()
 Indicates whether the effect requires rendering.
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from the effect.
 
template<typename T >
shared_ptr< TlookupObject (string_view relativePath)
 Lookup a relative object of a given type.
 
void setEffectPaddingChangeCounter (unsigned int value)
 Sets the effect quad padding change counter.
 
void setEnabled (bool value)
 Sets the value of EnabledProperty.
 
void setParent (NodeEffect2D *parent)
 Sets the parent of a node effect.
 
void setTemplateRoot (NodeEffect2DSharedPtr templateRoot)
 Sets the template root for this node effect.
 
void unregisterEffectRenderer (NodeEffectRenderer2D *effectRenderer)
 Unregister effect renderer.
 
 ~NodeEffect2D ()
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource.
 
const string & getName () const
 Gets the resource name.
 
const string & getUrl () const
 Gets the resource URL.
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set.
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag.
 
void setUrl (string_view url)
 Sets the resource URL.
 
 ~Resource () override
 Destructor.
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object.
 
void applyObjectStyles ()
 Apply all styles for an object node.
 
DomaingetDomain () const
 Returns the domain the object belongs to.
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object.
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain.
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object.
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object.
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object.
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object.
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles.
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it.
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers.
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container.
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object.
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object.
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers.
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type.
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers.
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property.
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property.
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value.
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties ()
 Remove all KZB properties.
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set.
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property.
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type.
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< NodeEffect2D >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot)
 Sets a binding with no target.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot)
 Sets a binding with no target.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding.
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes.
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes.
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index.
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node.
 
void removeAllBindings ()
 Removes all binding runtimes.
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier.
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner.
 

Static Public Member Functions

static ShadowEffect2DSharedPtr create (Domain *domain, string_view name)
 Creates a shadow effect.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 

Static Public Attributes

static PropertyType< Vector2ActualOffsetProperty
 Gets the calculated offset of the shadow from the object along the x and y axes in pixels.
 
static PropertyType< floatAngleProperty
 Sets the direction of the shadow as an angle relative to the positive x-axis.
 
static PropertyType< intBlendModeProperty
 Sets the blend mode to use for rendering the shadow.
 
static PropertyType< floatBlurRadiusProperty
 Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge.
 
static PropertyType< ColorRGBAColorProperty
 Sets the color of the shadow.
 
static PropertyType< floatDistanceProperty
 Sets how far to move the shadow from the object in the direction set by the AngleProperty.
 
static PropertyType< Vector2OverrideOffsetProperty
 Sets the offset of the shadow from the object along the x and y axes in pixels.
 
static PropertyType< QualityQualityProperty
 Sets the visual quality of the shadow.
 
static PropertyType< boolShadowOnlyProperty
 Sets whether to render only the shadow without the node contents.
 
static PropertyType< TypeTypeProperty
 Sets the type of the shadow:
 
- Static Public Attributes inherited from kanzi::NodeEffect2D
static PropertyType< boolEnabledProperty
 Sets whether the effect is enabled.
 

Protected Member Functions

NodeEffectRenderer2DUniquePtr createRendererOverride () override
 NodeEffect2D::createRendererOverride implementation.
 
void initializeRendererOverride () override
 NodeEffect2D::initializeRendererOverride implementation.
 
bool isRenderingRequiredOverride () override
 NodeEffect2D::isRenderingRequiredOverride() implementation.
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 PropertyObject::onPropertyChanged implementation.
 
 ShadowEffect2D (Domain *domain, string_view name)
 Constructor.
 
void updateEffectQuadPadding ()
 Update NodeEffect2D effect quad padding based on the current parameters.
 
void updatePremultipliedColor ()
 Update premultiplied color for the shadow effect.
 
void updateShadowOffset ()
 Update the shadow offset based on the shadow angle and distance.
 
- Protected Member Functions inherited from kanzi::NodeEffect2D
virtual ObjectSharedPtr lookupObjectOverride (string_view initialPart, string_view remainingPart)
 Lookup for an object from the effect.
 
 NodeEffect2D (Domain *domain, string_view name)
 Constructor.
 
virtual void onAttached ()
 Called by Kanzi when effect is attached.
 
virtual void onDetached ()
 Called by Kanzi when effect is detached.
 
void setAlphaRequired (bool required)
 Sets the framebuffer alpha channel requirements of the effect.
 
void setEffectQuadPadding (float left, float right, float top, float bottom)
 Sets the padding required by the effect around the node bounds during the rendering of the effect.
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadOverride ()
 
 Resource (Domain *domain, string_view name)
 Constructor.
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value.
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source.
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage.
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor.
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor.
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage.
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage.
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source.
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers.
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers.
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< NodeEffect2D >
NodeEffect2DgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern.
 
const NodeEffect2DgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern.
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object.
 
void detachBindings ()
 Detach bindings.
 

Protected Attributes

ClassPropertyDefaultValue< EffectStack2D::StackingModem_defaultStackingMode
 Default value for EffectStack2D::StackingModeProperty.
 
ColorRGBA m_premultipliedColor
 Premultiplied color for the shadow.
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object.
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object.
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container.
 

Detailed Description

Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes.

Examples

To create a shadow effect:

// An effect that is assigned to a 2D node is an effect prefab.
// Before you can construct an effect prefab, you must create an effect template.
// This example creates an effect template for the ShadowEffect2D effect prefab.
NodeEffectTemplate2DSharedPtr shadowEffectTemplate =
NodeEffectTemplate2D::create(ShadowEffect2D::getStaticMetaclass()->getName(), "DropShadow");
// Create a node effect prefab from the effect template.
NodeEffectPrefab2DSharedPtr shadowEffectPrefab =
NodeEffectPrefab2D::create(getDomain(), "DropShadow prefab", shadowEffectTemplate);

To set the shadow effect properties:

// Create an effect template.
NodeEffectTemplate2DSharedPtr shadowEffectTemplate =
NodeEffectTemplate2D::create(ShadowEffect2D::getStaticMetaclass()->getName(), "DropShadow");
// Set the value of the AngleProperty in the template. This value serves as the default value
// of the property in instances of the effect prefab.
shadowEffectTemplate->addPropertyValue(ShadowEffect2D::AngleProperty, Variant(35.f));
// Create an effect prefab.
NodeEffectPrefab2DSharedPtr shadowEffectPrefab =
NodeEffectPrefab2D::create(getDomain(), "DropShadow prefab", shadowEffectTemplate);
// Assign the effect to a 2D node.
node2d->setEffectPrefab(shadowEffectPrefab);
// Get the node-specific effect instance created from the assigned prefab.
ShadowEffect2DSharedPtr shadowEffect = dynamic_pointer_cast<ShadowEffect2D>(node2d->getEffect());
// Set the shadow distance to 15 pixels for this node only. This overrides
// the property default value defined by the ShadowEffect2D metaclass.
shadowEffect->setDistance(15.f);
// Set the direction of the shadow to 55 degrees relative to the positive x axis.
// This overrides the default value of 35 degrees set in the shadow effect template.
shadowEffect->setAngle(55.f);
See also
NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D
Since
Kanzi 3.9.0
Kanzi 3.9.5 added ShadowEffect2D::OverrideOffsetProperty.

Member Enumeration Documentation

◆ Type

Defines the types of the shadow effect.

Enumerator
DropShadow 

Drop shadow appears behind or below objects.

InnerShadow 

Inner shadow appears inside objects.

Count 

Number of shadow types.

◆ Quality

Defines the visual quality levels of the shadow effect.

Enumerator
Low 

Lowest shadow quality.

Normal 

Normal shadow quality. This is the default.

High 

High shadow quality.

Count 

Number of quality options.

Constructor & Destructor Documentation

◆ ShadowEffect2D()

kanzi::ShadowEffect2D::ShadowEffect2D ( Domain * domain,
string_view name )
explicitprotected

Constructor.

Parameters
domainDomain to use.
nameResource name.

Member Function Documentation

◆ getBlendMode()

int kanzi::ShadowEffect2D::getBlendMode ( ) const
inline

Gets the value of BlendModeProperty.

See also
setBlendMode()
Since
Kanzi 3.9.8

◆ setBlendMode()

void kanzi::ShadowEffect2D::setBlendMode ( int value)
inline

Sets the value of BlendModeProperty.

See also
getBlendMode()
Since
Kanzi 3.9.8

◆ getBlurRadius()

float kanzi::ShadowEffect2D::getBlurRadius ( ) const
inline

Gets the value of BlurRadiusProperty.

See also
setBlurRadius()

◆ setBlurRadius()

void kanzi::ShadowEffect2D::setBlurRadius ( float value)
inline

Sets the value of BlurRadiusProperty.

See also
getBlurRadius()

◆ getQuality()

Quality kanzi::ShadowEffect2D::getQuality ( ) const
inline

Gets the value of QualityProperty.

See also
setQuality()

◆ setQuality()

void kanzi::ShadowEffect2D::setQuality ( Quality value)
inline

Sets the value of QualityProperty.

See also
getQuality()

◆ getType()

Type kanzi::ShadowEffect2D::getType ( ) const
inline

Gets the value of TypeProperty.

See also
setType()

◆ setType()

void kanzi::ShadowEffect2D::setType ( Type value)
inline

Sets the value of TypeProperty.

See also
getType()

◆ getDistance()

float kanzi::ShadowEffect2D::getDistance ( ) const
inline

Gets the value of DistanceProperty.

See also
setDistance()

◆ setDistance()

void kanzi::ShadowEffect2D::setDistance ( float value)
inline

Sets the value of DistanceProperty.

See also
getDistance()

◆ getAngle()

float kanzi::ShadowEffect2D::getAngle ( ) const
inline

Gets the value of AngleProperty.

See also
setAngle()

◆ setAngle()

void kanzi::ShadowEffect2D::setAngle ( float value)
inline

Sets the value of AngleProperty.

See also
getAngle()

◆ getOverrideOffset()

Vector2 kanzi::ShadowEffect2D::getOverrideOffset ( ) const
inline

Gets the value of OverrideOffsetProperty.

See also
setOverrideOffset()
Since
Kanzi 3.9.6

◆ setOverrideOffset()

void kanzi::ShadowEffect2D::setOverrideOffset ( Vector2 value)
inline

Sets the value of OverrideOffsetProperty.

See also
getOverrideOffset()
Since
Kanzi 3.9.6

◆ getActualOffset()

Vector2 kanzi::ShadowEffect2D::getActualOffset ( ) const
inline

Gets the value of ActualOffsetProperty.

See also
setActualOffset()
Since
Kanzi 3.9.6

◆ getColor()

ColorRGBA kanzi::ShadowEffect2D::getColor ( ) const
inline

Gets the value of ColorProperty.

See also
setColor()

◆ setColor()

void kanzi::ShadowEffect2D::setColor ( ColorRGBA value)
inline

Sets the value of ColorProperty.

See also
getColor()

◆ getShadowOnly()

bool kanzi::ShadowEffect2D::getShadowOnly ( ) const
inline

Gets the value of ShadowOnlyProperty.

See also
setShadowOnly()

◆ setShadowOnly()

void kanzi::ShadowEffect2D::setShadowOnly ( bool value)
inline

Sets the value of ShadowOnlyProperty.

See also
getShadowOnly()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ShadowEffect2D::makeEditorInfo ( )
static

◆ create()

static ShadowEffect2DSharedPtr kanzi::ShadowEffect2D::create ( Domain * domain,
string_view name )
static

Creates a shadow effect.

Parameters
domainDomain to use.
nameResource name.
Returns
Shared pointer to the created ShadowEffect2D instance.

◆ getPremultipliedColor()

ColorRGBA kanzi::ShadowEffect2D::getPremultipliedColor ( ) const
inline

Gets the premultiplied color used by the shadow effect.

◆ createRendererOverride()

NodeEffectRenderer2DUniquePtr kanzi::ShadowEffect2D::createRendererOverride ( )
overrideprotectedvirtual

◆ initializeRendererOverride()

void kanzi::ShadowEffect2D::initializeRendererOverride ( )
overrideprotectedvirtual

◆ isRenderingRequiredOverride()

bool kanzi::ShadowEffect2D::isRenderingRequiredOverride ( )
overrideprotectedvirtual

◆ onPropertyChanged()

virtual void kanzi::ShadowEffect2D::onPropertyChanged ( AbstractPropertyType propertyType,
PropertyNotificationReason reason )
overrideprotectedvirtual

PropertyObject::onPropertyChanged implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ updateEffectQuadPadding()

void kanzi::ShadowEffect2D::updateEffectQuadPadding ( )
protected

Update NodeEffect2D effect quad padding based on the current parameters.

◆ updatePremultipliedColor()

void kanzi::ShadowEffect2D::updatePremultipliedColor ( )
protected

Update premultiplied color for the shadow effect.

◆ updateShadowOffset()

void kanzi::ShadowEffect2D::updateShadowOffset ( )
protected

Update the shadow offset based on the shadow angle and distance.

Member Data Documentation

◆ BlendModeProperty

PropertyType<int> kanzi::ShadowEffect2D::BlendModeProperty
static

Sets the blend mode to use for rendering the shadow.

See also
setBlendMode(), getBlendMode()
Since
Kanzi 3.9.8

◆ BlurRadiusProperty

PropertyType<float> kanzi::ShadowEffect2D::BlurRadiusProperty
static

Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge.

For a shadow with sharp edges, set to 0. The default value is 8.

See also
setBlurRadius(), getBlurRadius()

◆ QualityProperty

PropertyType<Quality> kanzi::ShadowEffect2D::QualityProperty
static

Sets the visual quality of the shadow.

Lower quality uses less computing and memory resources. The default value is Normal.

See also
setQuality(), getQuality()

◆ TypeProperty

PropertyType<Type> kanzi::ShadowEffect2D::TypeProperty
static

Sets the type of the shadow:

  • DropShadow appears behind or below an object. This is the default value.
  • InnerShadow appears inside an object.
    See also
    setType(), getType()

◆ DistanceProperty

PropertyType<float> kanzi::ShadowEffect2D::DistanceProperty
static

Sets how far to move the shadow from the object in the direction set by the AngleProperty.

The default value is 10.

See also
setDistance(), getDistance()

◆ AngleProperty

PropertyType<float> kanzi::ShadowEffect2D::AngleProperty
static

Sets the direction of the shadow as an angle relative to the positive x-axis.

The default value is 45.

See also
setAngle(), getAngle()

◆ OverrideOffsetProperty

PropertyType<Vector2> kanzi::ShadowEffect2D::OverrideOffsetProperty
static

Sets the offset of the shadow from the object along the x and y axes in pixels.

When you set this property, the AngleProperty and DistanceProperty have no effect. To disable the offset override, remove this property.

See also
setOverrideOffset(), getOverrideOffset()
Since
Kanzi 3.9.6

◆ ActualOffsetProperty

PropertyType<Vector2> kanzi::ShadowEffect2D::ActualOffsetProperty
static

Gets the calculated offset of the shadow from the object along the x and y axes in pixels.

Kanzi calculates the offset from the values of the DistanceProperty and AngleProperty or, if the OverrideOffsetProperty is set, from its value.

See also
setActualOffset(), getActualOffset()
Since
Kanzi 3.9.6

◆ ColorProperty

PropertyType<ColorRGBA> kanzi::ShadowEffect2D::ColorProperty
static

Sets the color of the shadow.

The default value is ColorRGBA(0.f, 0.f, 0.f, 0.75f).

See also
setColor(), getColor()

◆ ShadowOnlyProperty

PropertyType<bool> kanzi::ShadowEffect2D::ShadowOnlyProperty
static

Sets whether to render only the shadow without the node contents.

The default value is false.

See also
setShadowOnly(), getShadowOnly()

◆ m_premultipliedColor

ColorRGBA kanzi::ShadowEffect2D::m_premultipliedColor
protected

Premultiplied color for the shadow.

◆ m_defaultStackingMode

ClassPropertyDefaultValue<EffectStack2D::StackingMode> kanzi::ShadowEffect2D::m_defaultStackingMode
protected

The documentation for this class was generated from the following file: